home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / basic / qblink.exe / QBLINK.HLP < prev    next >
Encoding:
Text File  |  1993-01-08  |  15.4 KB  |  193 lines

  1. ┌─────────────────────── »»»  QBLink Help Screen  ««« ─────────────── 1 ───────┐
  2. │       Welcome to QBLink.I hope you find this program easy to use.            │
  3. │     This program will allow you to compile & link your programs in a very    │
  4. │ flexible manner.You may find as your programs get larger that you will want  │
  5. │ to use different compiler options with different modules.This is easily done │
  6. │ with QBLink.You may however,prefer to compile & link your program all in one │
  7. │ step.Whether your program consists of a single source file or many modules,  │
  8. │ YOU have complete control over the compile & link options.                   │
  9. │ ═════════════════════════════════*NOTE*════════════════════════════════════  │
  10. │     You must set an environment variable pointing to the directory that con- │
  11. │ tains your Basic Include (.BI) files, or BC.EXE will not be able to find     │
  12. │ them. Add the statement SET INCLUDE=drive\directory (where drive\directory is│
  13. │ where your include files are) to your AUTOEXEC.BAT file. It would be good    │
  14. │ practice to also place SET LIB=drive\directory for your .LIB files.          │
  15. │ ═══════════════════════════════════════════════════════════════════════════  │
  16. │     Each menu title or menu item can be selected by the highlighted          │
  17. │ letter or "hot" key,or by moving the highlight with the cursor and press-    │
  18. │ ing <ENTER>. You can also use a mouse to select items.                       │
  19. │ Directory,source file,& library file selections will open an edit window for │
  20. │ the required data.Case is not important.Allowed editing keys include         │
  21. │ backspace,home,end,cursor keys, ctrl-y,ctrl-t. Pressing ENTER will complete  │
  22. │ input,ESC will exit with no changes.Insert is on by default,but may be tog-  │
  23. │ gled. Option windows REQUIRE use of a mouse as of this writing.              │
  24. └────────────────────  <page down> or <escape> to quit  ───────────────────────┘
  25. ┌──────────────────────────────────────────────────────────────────── 2 ───────┐
  26. │                               Quick Start                                  │
  27. │     ALL options present on-screen will be included when compiling/linking.   │
  28. │     If an .MAK file exists for your program,you may enter the name in the    │
  29. │  Source File field (include .MAK extension) if you wish to either compile or │
  30. │  link (or both) all modules at once listed in the .MAK file.                 │
  31. │     Your .MAK file must exist in the same directory you have listed for your │
  32. │  .BAS (source) files.The .MAK file will be the template for a response file. │
  33. │     You may optionally choose to compile or link individual files.This will  │
  34. │  enable you to utilize different compiler options for different modules, or  │
  35. │  for several modules concurrently. Multiple source files may be listed in    │
  36. │  the Source File area whether compiling or linking,by separating each name   │
  37. │  with a space or a "+" . Do not use any file extensions anywhere within this │
  38. │  program except the .MAK extension when listing one filename in the Source   │
  39. │  File field. Object files created will be placed in the same directory as    │
  40. │  your source files, and that is where QBLink will look.                      │
  41. │     Check the menu to save information on screen to file.                    │
  42. │     A Link Response file will created in the same directory as your source   │
  43. │  files,then deleted after linking.                                           │
  44. │     If you intend to link multiple entries in the Source area,the FIRST entry│
  45. │  will become the name of your executable file.                               │
  46. │     Be sure to enter a proper Library name(s) for linking.                   │
  47. │     Quick Libraries are supported. Check your QB manual for details.         │
  48. └────────────────────  <pagedown> <pageup> <home> or <escape>  ────────────────┘
  49. ┌──────────────────────────╦══════════════════╦────────────────────── 3 ───────┐
  50. │                          ║  Exit/Utils menu ║                                │
  51. │                          ╚══════════════════╝                                │
  52. │                                                                              │
  53. │*DOS Shell*                                                                   │
  54. │    If you need to get to the DOS prompt to do some work,this will get        │
  55. │ you there.Just type EXIT to return to QBLink and the current directory.      │
  56. │                                                                              │
  57. │*Exit*                                                                        │
  58. │    Quit QBLink.                                                              │
  59. │                                                                              │
  60. │*Save Configuration*                                                          │
  61. │    This will take any information present in the fields on screen and        │
  62. │ save it to disk, which will then be read the next time you start QBLink.     │
  63. │    You may save a new configuration as often as you like,which will replace  │
  64. │ any current configuration file.                                              │
  65. │    The configuration filename is QBLINK.CFG. If you accidently delete it,    │
  66. │ just enter your options in the program and save them again. The configuration│
  67. │ file will be created in the same directory as this program.                  │
  68. │                                                                              │
  69. │                                                                              │
  70. │                                                                              │
  71. │                                                                              │
  72. └──────────────── <pagedown> <pageup> <home> or <escape> to quit ──────────────┘
  73. ┌─────────────────────────────╦═══════════╦────────────────────────── 4 ───────┐
  74. │                             ║ File menu ║                                    │
  75. │                             ╚═══════════╝                                    │
  76. │*Executable File Directory*                                                   │
  77. │    The drive and/or directory where you keep BC.EXE & LINK.EXE.              │
  78. │*Basic File Directory*                                                        │
  79. │    The drive and/or directory where you keep your basic (source) files.      │
  80. │*Library File Directory*                                                      │
  81. │    The drive and/or directory that contains your library (.LIB) files.       │
  82. │    It's not mandatory,but placing SET LIB=drive\directory in your autoexec   │
  83. │    file will enable LINK to search for any libraries you may not have listed.│
  84. │*Source Filename*                                                             │
  85. │    This entry is for the file(s) you wish to compile and/or link.            │
  86. │    You would make a single filename entry here to:                           │
  87. │  Compile & link a single module;                                             │
  88. │  Compile OR link all modules in your program at once (if a .MAK file exists) │
  89. │  Compile AND link all program modules at once (if a .MAK file exists).       │
  90. │    Multiple entries are allowed to:                                          │
  91. │  Compile several modules with same compiler options;                         │
  92. │  Link several modules.                                                       │
  93. │    Remember,use the .mak extension when necessary, otherwise when listing    │
  94. │ multiple files,separate each with a space or a "+". OK?                      │
  95. │                                                                              │
  96. └────────────  <pagedown> <pageup> <home> or <escape> to quit ─────────────────┘
  97. ┌────────────────────────────╦══════════════╦──────────────────────── 5 ───────┐
  98. │                            ║ Options menu ║                                  │
  99. │                            ╚══════════════╝                                  │
  100. │*Compiler Options*                                                            │
  101. │    Just click on the compiler options you wish to use. If you select /C:     │
  102. │ (communications buffer) an edit line will open at the bottom of the          │
  103. │ window for you to enter the buffer size. After making an entry, press        │
  104. │ < enter > to confirm the entry.                                              │
  105. │   List files are not supported with the exception of the /Assembly listing   │
  106. │ which will instruct the compiler to generate an assembly-language listing    │
  107. │ of your compiled code.                                                       │
  108. │   Right mouse button or <ESC> confirms Compiler Options and exits to main    │
  109. │ menu screen.                                                                 │
  110. │*Linker Options*                                                              │
  111. │   As before, just click on the link options you want.Any switches that       │
  112. │ require additional input will open an editor at the bottom of the window.    │
  113. │ Press <enter> to confirm entry or <esc> to abort. /HELP and /BATCH options   │
  114. │ are NOT supported, so are not listed.                                        │
  115. │ *NOTE* The /quicklib option is supported.This one can be tricky if you have  │
  116. │ duplicate procedures in different libraries.However,no harm will be done.    │
  117. │ Just watch the screen when you LINK for any error messages.If you fail to    │
  118. │ see an error message,LINK may create the Quicklibrary,but it may fail to     │
  119. │ work properly. Enter the correct support library to link with.               │
  120. └─────────────────  <pagedn> <pageup> <home> or <esc> to quit  ────────────────┘
  121. ┌──────────────────────────────────────────────────────────────────── 6 ───────┐
  122. │ (continuing Options menu)                                                    │
  123. │                                                                              │
  124. │*Libraries*                                                                   │
  125. │    This entry is for any libraries your program needs to link with.          │
  126. │    Do not enter the .LIB extension when listing libraries.                   │
  127. │    Separate each library name with a space.                                  │
  128. │    At the time of this writing, you must make some entry here,else you will  │
  129. │  not be able to Link.                                                        │
  130. │  For example,if you are using QB45 and wish to make a stand-alone executable │
  131. │  file, you would link with BCOM45.LIB, so just type BCOM45.                  │
  132. │    Several library names may be entered if necessary. If you Link with a     │
  133. │  library other than the default,list that library. If you have the SET LIB=  │
  134. │  environment variable and your program needs one of the libs supplied with   │
  135. │  BASIC, LINK will search for it. For example,if you have created FOOBAR.LIB  │
  136. │  but your program still needs BCL71EFR.LIB supplied with BASIC PDS, try      │
  137. │  entering just FOOBAR & let LINK search for the BASIC-supplied library.      │
  138. │*Stub Files*                                                                  │
  139. │    Just use the mouse to select the ones you need. I caution here that if you│
  140. │  are using QB and not QBX you know which ones apply for you. Make sure any   │
  141. │  stub files ( nocom.obj,smallerr.obj,etc) are where LINK can find them, typ- │
  142. │  ically in the same directory as your library files.                         │
  143. │                                                                              │
  144. └──────────────  <pagedn> <pageup> <home> or <esc> to quit  ───────────────────┘
  145. ┌───────────────────────────────╦══════════╦───────────────────────── 7 ───────┐
  146. │                               ║ RUN MENU ║                                   │
  147. │*Compile*                      ╚══════════╝                                   │
  148. │    This menu option will compile the entries you have in the Source File     │
  149. │  field and use the compiler options you have selected.                       │
  150. │    Remember,you may compile several source files in one run. If there exists │
  151. │  an .MAK file for your program and you wish to compile all the files in your │
  152. │  program with the same options, then be sure to list the .MAK file in the    │
  153. │  in the Source File field. QBLink will use the make file as a guide as to    │
  154. │  which files are part of your program, and compile each one.                 │
  155. │    ANY set of individual files listed in the Source File area will be comp-  │
  156. │ iled. Remember,when using an .MAK file,only list that filename with the .MAK │
  157. │ extension. Object files will created in the same directory as your source.   │
  158. │     Separate multiple filenames with either a "+" or one space.            │
  159. │*Link*                                                                        │
  160. │    This menu option will link whatever entries you have in the Source File   │
  161. │ area (and use whatever link options,stub files & libraries you have selected)│
  162. │ provided you have already compiled them.                                     │
  163. │    If an .MAK file exists for your program, be sure to list the proper file  │
  164. │ with the .MAK extension in the Source File area(and no others). QBLink will  │
  165. │ read the .MAK file and use it as a template to create a Link response file.  │
  166. │   The response file (LINKER.RSP) will be created in the same directory as    │
  167. │ your source files and deleted upon a successful link operation.              │
  168. └────────────────  <pagedn> <pageup> <home> or <esc> to quit  ─────────────────┘
  169. ┌──────────────────────────────────────────────────────────────────── 8 ───────┐
  170. │ (continuing Run menu)                                          (last page)   │
  171. │                                                                              │
  172. │*Compile & Link*                                                              │
  173. │   This menu option is essentially a combination of the previous two options. │
  174. │ All that applies to Compile and to Link will apply here.                     │
  175. │   Again, if you have a program for which an .MAK file exists, then you       │
  176. │ may enter the .MAK filename in the Source File field and all modules listed  │
  177. │ in the .MAK file will be compiled and linked, including whatever options,    │
  178. │ stub files, and libraries you have selected.                                 │
  179. │                                                                              │
  180. │  Once again, if you make multiple entries in the Source File area,just be    │
  181. │ sure to separate each with either one space or a "+".                        │
  182. │                                                                              │
  183. │                                                                              │
  184. │                                                                              │
  185. │                                                                              │
  186. │                                                                              │
  187. │                                                                              │
  188. │                                                                              │
  189. │                                                                              │
  190. │                                                                              │
  191. │                                                                              │
  192. └─────────────────────  <pageup> <home> or <esc> to quit  ─────────────────────┘
  193.